/*
 * File Name     : @(#)HCISEntity.java
 * Creation Date : Mar 2, 2009
 * Author        : anirudh
 * 
 * Copyright 2009 Anirudh Vyas
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package hcis.model.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Provides a namespace to a domain type. Anything or everything in a domain is an entity, Something which is not marked with an entity annotation will not be considered by the core container for
 * further processing. Example usage: <br />
 * 
 * <pre>
 * 		&#064;HCISEntity(name=&quot;SomeDomainTypeModelEntity&quot;, description=&quot;A dummy entity&quot;) public class SomeDomainTypeModel{ // Some code here ... }
 * </pre>
 * 
 * @author anirudh
 */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface HCISEntity {

	/**
	 * Attribute name for the entity.
	 * 
	 * @return name for the entity.
	 */
	public abstract String name() default "DEFAULT";

	/**
	 * Attribute description for the entity.
	 * 
	 * @return description for the entity.
	 */
	public abstract String description() default "Not Applicable";
}
